package com.alibaba.excel.read.metadata;

import java.io.File;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.Set;

import javax.xml.parsers.SAXParserFactory;

import com.alibaba.excel.cache.ReadCache;
import com.alibaba.excel.cache.selector.ReadCacheSelector;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.enums.CellExtraTypeEnum;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.read.listener.ModelBuildEventListener;
import com.alibaba.excel.support.ExcelTypeEnum;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;

/**
 * Workbook
 *
 * @author Jiaju Zhuang
 **/
@Getter
@Setter
@EqualsAndHashCode
public class ReadWorkbook extends ReadBasicParameter {
    public ReadWorkbook() {// 这个类封装excel文件，和读取时的行为设置
        super();
    }

    /**
     * Excel type
     */
    // Excel类型
    private ExcelTypeEnum excelType;
    /**
     * Read InputStream
     * <p>
     * If 'inputStream' and 'file' all not empty, file first
     */
    // 读取输入流
    // 如果 'inputStream' 和 'file' 都不是空的，文件优先
    private InputStream inputStream;
    /**
     * Read file
     * <p>
     * If 'inputStream' and 'file' all not empty, file first
     */
    // 读取文件
    // 如果 'inputStream' 和 'file' 都不是空的，文件优先
    private File file;
    /**
     * charset.
     * Only work on the CSV file
     */
    // 字符集。仅适用于 CSV 文件
    private Charset charset;
    /**
     * Mandatory use 'inputStream' .Default is false.
     * <p>
     * if false, Will transfer 'inputStream' to temporary files to improve efficiency
     */
    // 强制使用'inputStream'。默认为假。
    // 如果为false，将'inputStream'传输到临时文件以提高效率
    private Boolean mandatoryUseInputStream;
    /**
     * Default true
     */
    // 自动关闭流
    private Boolean autoCloseStream;
    /**
     * This object can be read in the Listener {@link AnalysisEventListener#invoke(Object, AnalysisContext)}
     * {@link AnalysisContext#getCustom()}
     *
     */
    // 这个对象可以在监听器中读取到
    // 参见 AnalysisEventListener.invoke(Object, AnalysisContext)
    // 参见 AnalysisContext.getCustom()
    private Object customObject;
    /**
     * A cache that stores temp data to save memory.
     */
    // 存储临时数据以节省内存的缓存。
    private ReadCache readCache;
    /**
     * Ignore empty rows.Default is true.
     */
    // 忽略空行。默认为真
    private Boolean ignoreEmptyRow;
    /**
     * Select the cache.Default use {@link com.alibaba.excel.cache.selector.SimpleReadCacheSelector}
     */
    // 选择缓存。默认使用com.alibaba.excel.cache.selector.SimpleReadCacheSelector
    private ReadCacheSelector readCacheSelector;
    /**
     * Whether the encryption
     */
    // 是否加密
    private String password;
    /**
     * SAXParserFactory used when reading xlsx.
     * <p>
     * The default will automatically find.
     * <p>
     * Please pass in the name of a class ,like : "com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl"
     *
     * @see SAXParserFactory#newInstance()
     * @see SAXParserFactory#newInstance(String, ClassLoader)
     */
    // 读取 xlsx 时使用的 SAXParserFactory。
    // 默认会自动查找。
    // 请传入一个类的名称，例如：“com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl”
    // 也可以看看：
    // SAXParserFactory.newInstance() , SAXParserFactory.newInstance(String, ClassLoader)
    private String xlsxSAXParserFactoryName;
    /**
     * Whether to use the default listener, which is used by default.
     * <p>
     * The {@link ModelBuildEventListener} is loaded by default to convert the object.
     */
    // 是否使用默认监听器，默认使用。
    // 默认加载ModelBuildEventListener以转换对象。
    private Boolean useDefaultListener;
    /**
     * Read some additional fields. None are read by default.
     *
     * @see CellExtraTypeEnum
     */
    // 阅读一些附加字段。默认情况下不读取任何内容。
    // 也可以看看：
    // CellExtraTypeEnum
    private Set<CellExtraTypeEnum> extraReadSet;
}
